/* Copyright  2009
   @Author
   Richard Changde Yin            e-mail yinchangde@hotmail.com

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; version 2 of the License.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */

/*
*  @filename : collapsar_time.h
*/

#ifndef __SRV_TIME_H__
#define __SRV_TIME_H__


enum enum_collapsar_timestamp_type
{
  COLLAPSAR_TIMESTAMP_NONE            = -2,
  COLLAPSAR_TIMESTAMP_ERROR           = -1,
  COLLAPSAR_TIMESTAMP_DATE            = 0 ,
  COLLAPSAR_TIMESTAMP_DATETIME        = 1 ,
  COLLAPSAR_TIMESTAMP_TIME            = 2
};


/*
  Structure which is used to represent datetime values inside database.

  We assume that values in this structure are normalized, i.e. year <= 9999,
  month <= 12, day <= 31, hour <= 23, hour <= 59, hour <= 59. Many functions
  in server such as my_system_gmt_sec() or make_time() family of functions
  rely on this (actually now usage of make_*() family relies on a bit weaker
  restriction). Also functions that produce COLLAPSAR_TIME as result ensure this.
  There is one exception to this rule though if this structure holds time
  value (time_type == COLLAPSAR_TIMESTAMP_TIME) days and hour member can hold
  bigger values.
*/
typedef struct st_collapsar_time
{
  unsigned int year  ;
  unsigned int month ;
  unsigned int day   ;
  unsigned int hour  ;
  unsigned int minute;
  unsigned int second;
  unsigned long second_part;
  bool          neg;
  enum enum_collapsar_timestamp_type         time_type;
} COLLAPSAR_TIME;

#endif /* __SRV_TIME_H__ */
